QmiDMS.h

/*===========================================================================
FILE: 
   QmiDMSAPI.h

DESCRIPTION:
   QMI Device Management Service APIs. Service type 0x02

Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
                   Sierra Wireless Proprietary/GTDR
==========================================================================*/

#ifndef __QMI_DMS_API_H__
#define __QMI_DMS_API_H__
/*=========================================================================*/
// Definitions
/*=========================================================================*/


/*=========================================================================*/
// Structs
/*=========================================================================*/
#ifdef __cplusplus
        extern "C" {
#endif

#ifdef __cplusplus
        };
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/
typedef enum
{
    GobiPowerMode_Online = 0,
    GobiPowerMode_Low,// 1
    GobiPowerMode_FactoryTest, // 2
    GobiPowerMode_Offline,// 3
    GobiPowerMode_Reset,// 4
    GobiPowerMode_Off,// 5
    GobiPowerMode_PersistentLow // 6
} eGobiPowerMode;
IMPORTGOBI ULONG GOBICMAPI SetPowerCallback( tFNPower pCallback );

IMPORTGOBI ULONG GOBICMAPI SetActivationStatusCallback( 
   tFNActivationStatus        pCallback );

IMPORTGOBI ULONG GOBICMAPI DMSUIMGetICCID( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI DMSUIMGetControlKeyStatus( 
   ULONG                      id, 
   ULONG *                    pStatus,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );


IMPORTGOBI ULONG GOBICMAPI DMSUIMSetControlKeyProtection( 
   ULONG                      id, 
   ULONG                      status,
   CHAR *                     pValue,
   ULONG *                    pVerifyRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockControlKey( 
   ULONG                      id, 
   CHAR *                     pValue,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMSetPINProtection( 
   ULONG                      id, 
   ULONG                      bEnable,
   CHAR *                     pValue,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMVerifyPIN( 
   ULONG                      id, 
   CHAR *                     pValue,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMUnblockPIN( 
   ULONG                      id, 
   CHAR *                     pPUKValue,
   CHAR *                     pNewValue,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMChangePIN( 
   ULONG                      id, 
   CHAR *                     pOldValue,
   CHAR *                     pNewValue,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI DMSUIMGetPINStatus( 
   ULONG                      id, 
   ULONG *                    pStatus,
   ULONG *                    pVerifyRetriesLeft,
   ULONG *                    pUnblockRetriesLeft );

IMPORTGOBI ULONG GOBICMAPI GetHardwareRevision( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI GetPRLVersion( WORD * pPRLVersion );

IMPORTGOBI ULONG GOBICMAPI GetERIFile( 
   ULONG *                    pFileSize, 
   BYTE *                     pFile );

IMPORTGOBI ULONG GOBICMAPI ActivateAutomatic( CHAR * pActivationCode );

IMPORTGOBI ULONG GOBICMAPI ActivateManual( 
   CHAR *                     pSPC,
   WORD                       sid, 
   CHAR *                     pMDN,
   CHAR *                     pMIN, 
   ULONG                      prlSize, 
   BYTE *                     pPRL, 
   CHAR *                     pMNHA,
   CHAR *                     pMNAAA );

IMPORTGOBI ULONG GOBICMAPI ResetToFactoryDefaults( CHAR * pSPC );

IMPORTGOBI ULONG GOBICMAPI GetActivationState( ULONG * pActivationState );

IMPORTGOBI ULONG GOBICMAPI SetPower( ULONG powerMode );

IMPORTGOBI ULONG GOBICMAPI GetPower( ULONG * pPowerMode );

IMPORTGOBI ULONG GOBICMAPI GetOfflineReason( 
   ULONG *                    pReasonMask,
   ULONG *                    pbPlatform );

IMPORTGOBI ULONG GOBICMAPI GetNetworkTime( 
   ULONGLONG *                pTimeCount,  
   ULONG *                    pTimeSource );

IMPORTGOBI ULONG GOBICMAPI ValidateSPC( CHAR * pSPC );

IMPORTGOBI ULONG GOBICMAPI GetDeviceCapabilities( 
   ULONG *                    pMaxTXChannelRate, 
   ULONG *                    pMaxRXChannelRate, 
   ULONG *                    pDataServiceCapability, 
   ULONG *                    pSimCapability, 
   ULONG *                    pRadioIfacesSize, 
   BYTE *                     pRadioIfaces );

IMPORTGOBI ULONG GOBICMAPI GetManufacturer( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI GetModelID( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevision( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI GetFirmwareRevisions( 
   BYTE                       amssSize, 
   CHAR *                     pAMSSString,
   BYTE                       bootSize, 
   CHAR *                     pBootString,
   BYTE                       priSize, 
   CHAR *                     pPRIString );

IMPORTGOBI ULONG GOBICMAPI GetFirmwareInfo( 
   ULONG *                    pFirmwareID,
   ULONG *                    pTechnology,
   ULONG *                    pCarrier,
   ULONG *                    pRegion,
   ULONG *                    pGPSCapability );

IMPORTGOBI ULONG GOBICMAPI GetVoiceNumber( 
   BYTE                       voiceNumberSize, 
   CHAR *                     pVoiceNumber,
   BYTE                       minSize, 
   CHAR *                     pMIN );

IMPORTGOBI ULONG GOBICMAPI GetIMSI( 
   BYTE                       stringSize, 
   CHAR *                     pString );

IMPORTGOBI ULONG GOBICMAPI GetSerialNumbers( 
   BYTE                       esnSize, 
   CHAR *                     pESNString, 
   BYTE                       imeiSize, 
   CHAR *                     pIMEIString, 
   BYTE                       meidSize, 
   CHAR *                     pMEIDString );

IMPORTGOBI ULONG GOBIAPI GetStoredImages( 
   ULONG *                    pImageListSize, 
   BYTE *                     pImageList );

IMPORTGOBI ULONG GOBIAPI SetImagesPreference( 
   ULONG                      imageListSize, 
   BYTE *                     pImageList,
   ULONG                      bForceDownload,
   BYTE                       modemIndex,
   ULONG *                    pImageTypesSize, 
   BYTE *                     pImageTypes );

IMPORTGOBI ULONG GOBIAPI GetImagesPreference( 
   ULONG *                    pImageListSize, 
   BYTE *                     pImageList );   

IMPORTGOBI ULONG GOBIAPI ResetDevice(); // End of DMS group
#endif